/*
 Copyright 2022 Splendo Consulting B.V. The Netherlands

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

 */

package com.splendo.kaluga.architecture.viewmodel

import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.SupervisorJob
import kotlinx.coroutines.cancelChildren

/**
 * Simple ViewModel class that is to be bound to a View lifecycle
 */
actual open class LifecycleViewModel internal actual constructor() {

    private val lifecycleJob = SupervisorJob()

    /**
     * [CoroutineScope] of the ViewModel.
     * This scope is active until the ViewModel lifecycle is cleared.
     */
    actual val coroutineScope = CoroutineScope(Dispatchers.Main + lifecycleJob)

    /**
     * Call this when the [LifecycleViewModel] should be cleared to cancel all its coroutines.
     */
    fun clear() {
        onCleared()
    }

    /**
     * Called when the ViewModel lifecycle is cleared
     */
    protected actual open fun onCleared() {
        lifecycleJob.cancelChildren()
    }
}
